## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##
##  File Name:  sampleFile.tcl
##  @short      Add a short description.  
##  @author     Original author - sampleName
##  @date       Original date - sampleDate
##  @version    sampleVersion   Initial release
##
##  @comment    This source file provides a template that is to be used for
##  @c          creating Tcl Procedure Modules.  It is assumed that the autodoc
##  @c          utility is installed.  These comments should be replaced.  
##  @c          Note that this comment section is continued over several lines.  
##  @c          The comment tag and its abbreviation are used throughout to keep 
##  @c          the paragraphs of the comment block together in the automatic 
##  @c          documentation.
##  @c
##  @c          Also remember that the autodoc utility will automatically
##  @c          insert block headers for the sections
##  @c
##  @note       This is the notes section.
##  @n          Put any notes here that will help future maintainers of the
##  @n          code.  Try to be specific, but don't just duplicate things
##  @n          that are already in the comments in the file.
## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##  Revision history
##  ----------------
##
##          Rev    Rev. Date   Released by:  Revision Description
##         -----  -----------  ------------  --------------------------------
## version sampleVersion    sampleDate   sampleName    
##
## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##  SET UP MODULE GLOBAL VARIABLES HERE
##
##  This section is to declare the variables.  Although Tcl is a dynamically
##  scoped language, meaning you can declare variables "on the fly", it is
##  cleaner not to do that; hence, put them all here so they are all in one
##  place and easy to find.  Also, there can be a "delete variables" section
##  at the end of the script if you need it for arrays and such.
## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

proc samplePackage::sampleFile { paramList } {
## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##  Proc Name: sampleFile
##  @short     Short description of the procedure.  
##  @argument  param1    First argument to the procedure
##  @a         param2    Second argument to the procedure
##  @result    what the procedure should return
##  @example   an example use of the procedure
##
##  @comment   This procedure provides a template for how to code up all your
##  @c         procedures.  If there are multiple procedures in
##  @c         a single file, separate them with a couple of blank lines and
##  @c         put one of these header blocks at the start of each procedure.  
##  @c
##  @c         Note that the description block starts on the line after the
##  @c         procedure declaration.  This is required so that the autodoc
##  @c         generator will properly equate the comments and description
##  @c         to the procedure declaration.
##
##  @note      This is where to put special things that are artifacts of the
##  @n         procedure, like side effects and algorithm notes.
##
##  @danger    This is the section to put anything that the caller needs to
##  @d         be aware or wary of when using the procedure.  Most of the
##  @d         time this will just say "None."
## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

}
